Summary

Fully Qualified Name:	Laminas\Authentication\Validator\Authentication
Extends:	AbstractValidator

Description

Methods

Name	Description	Defined By
__construct()	Sets validator options	Authentication
__get()	Magic function returns the value of the requested property, if and only if it is the value or a message variable.	AbstractValidator
__invoke()	Invoke as command	AbstractValidator
getAdapter()	Get Adapter	Authentication
getCredential()	Get Credential	Authentication
getDefaultTranslator()	Get default translation object for all validate objects	AbstractValidator
getDefaultTranslatorTextDomain()	Get default translation text domain for all validate objects	AbstractValidator
getIdentity()	Get Identity	Authentication
getMessageLength()	Returns the maximum allowed message length	AbstractValidator
getMessageTemplates()	Returns the message templates from the validator	AbstractValidator
getMessageVariables()	Returns an array of the names of variables that are used in constructing validation failure messages	AbstractValidator
getMessages()	Returns array of validation failure messages	AbstractValidator
getOption()	Returns an option	AbstractValidator
getOptions()	Returns all available options	AbstractValidator
getService()	Get Service	Authentication
getTranslator()	Return translation object	AbstractValidator
getTranslatorTextDomain()	Return the translation text domain	AbstractValidator
hasDefaultTranslator()	Is there a default translation object set?	AbstractValidator
hasTranslator()	Does this validator have its own specific translator?	AbstractValidator
isTranslatorEnabled()	Is translation enabled?	AbstractValidator
isValid()	Returns true if and only if authentication result is valid	Authentication
isValueObscured()	Retrieve flag indicating whether or not value should be obfuscated in messages	AbstractValidator
setAdapter()	Set Adapter	Authentication
setCredential()	Set Credential	Authentication
setDefaultTranslator()	Set default translation object for all validate objects	AbstractValidator
setDefaultTranslatorTextDomain()	Set default translation text domain for all validate objects	AbstractValidator
setIdentity()	Set Identity	Authentication
setMessage()	Sets the validation failure message template for a particular key	AbstractValidator
setMessageLength()	Sets the maximum allowed message length	AbstractValidator
setMessages()	Sets validation failure message templates given as an array, where the array keys are the message keys, and the array values are the message template strings.	AbstractValidator
setOptions()	Sets one or multiple options	AbstractValidator
setService()	Set Service	Authentication
setTranslator()	Set translation object	AbstractValidator
setTranslatorEnabled()	Indicate whether or not translation should be enabled	AbstractValidator
setTranslatorTextDomain()	Set translation text domain	AbstractValidator
setValueObscured()	Set flag indicating whether or not value should be obfuscated in messages	AbstractValidator

Method Details

__construct()

Sets validator options

Parameter Name	Type	Description
$options	array|\Traversable

Returns:

__get()

Magic function returns the value of the requested property, if and only if it is the value or a message variable.

Parameter Name	Type	Description
$property	string

Returns: mixed

__invoke()

Invoke as command

Parameter Name	Type	Description
$value	mixed

Returns: bool

getAdapter()

Get Adapter

Returns: \ValidatableAdapterInterface

getCredential()

Get Credential

Returns: mixed

getDefaultTranslator()

Get default translation object for all validate objects

Returns: \Translator\TranslatorInterface|null

getDefaultTranslatorTextDomain()

Get default translation text domain for all validate objects

Returns: string

getIdentity()

Get Identity

Returns: mixed

getMessageLength()

Returns the maximum allowed message length

Returns: int

getMessageTemplates()

Returns the message templates from the validator

Returns: array

getMessageVariables()

Returns an array of the names of variables that are used in constructing validation failure messages

Returns: array

getMessages()

Returns array of validation failure messages

Returns: array

getOption()

Returns an option

Parameter Name	Type	Description
$option	string	Option

Returns: mixed Returned option

getOptions()

Returns all available options

Returns: array Array with all available options

getService()

Get Service

Returns: \AuthenticationService

getTranslator()

Return translation object

Returns: \Translator\TranslatorInterface|null

getTranslatorTextDomain()

Return the translation text domain

Returns: string

hasDefaultTranslator()

Is there a default translation object set?

Returns: bool

hasTranslator()

Does this validator have its own specific translator?

Returns: bool

isTranslatorEnabled()

Is translation enabled?

Returns: bool

isValid()

Returns true if and only if authentication result is valid

If authentication result fails validation, then this method returns false, and getMessages() will return an array of messages that explain why the validation failed.

Parameter Name	Type	Description
$value	null|mixed	OPTIONAL
$context	null|array	OPTIONAL

Returns: bool

isValueObscured()

Retrieve flag indicating whether or not value should be obfuscated in messages

Returns: bool

setAdapter()

Set Adapter

Parameter Name	Type	Description
$adapter	\ValidatableAdapterInterface

Returns: self Provides a fluent interface

setCredential()

Set Credential

Parameter Name	Type	Description
$credential	mixed

Returns: self Provides a fluent interface

setDefaultTranslator()

Set default translation object for all validate objects

Parameter Name	Type	Description
$translator	\Translator\TranslatorInterface|null
$textDomain	string	(optional)

Returns: void

setDefaultTranslatorTextDomain()

Set default translation text domain for all validate objects

Parameter Name	Type	Description
$textDomain	string

Returns: void

setIdentity()

Set Identity

Parameter Name	Type	Description
$identity	mixed

Returns: self Provides a fluent interface

setMessage()

Sets the validation failure message template for a particular key

Parameter Name	Type	Description
$messageString	string
$messageKey	string	OPTIONAL

Returns: $this Provides a fluent interface

setMessageLength()

Sets the maximum allowed message length

Parameter Name	Type	Description
$length	int

Returns:

setMessages()

Sets validation failure message templates given as an array, where the array keys are the message keys, and the array values are the message template strings.

Parameter Name	Type	Description
$messages	array

Returns: $this

setOptions()

Sets one or multiple options

Parameter Name	Type	Description
$options	array|\Traversable	Options

Returns: $this Provides fluid interface

setService()

Set Service

Parameter Name	Type	Description
$service	\AuthenticationService

Returns: self Provides a fluent interface

setTranslator()

Set translation object

Parameter Name	Type	Description
$translator	\Translator\TranslatorInterface|null
$textDomain	string	(optional)

Returns: $this

setTranslatorEnabled()

Indicate whether or not translation should be enabled

Parameter Name	Type	Description
$flag	bool

Returns: $this

setTranslatorTextDomain()

Set translation text domain

Parameter Name	Type	Description
$textDomain	string

Returns: $this

setValueObscured()

Set flag indicating whether or not value should be obfuscated in messages

Parameter Name	Type	Description
$flag	bool

Returns: $this